home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Collection of Tools & Utilities
/
Collection of Tools and Utilities.iso
/
tex
/
mspantoc.zip
/
MSP10.DOC
< prev
next >
Wrap
Text File
|
1987-01-20
|
131KB
|
3,975 lines
MSPANTOC MSPANTOC
Version 1.0
A Document Processing Utility
Paragraph Numbering
Symbolic Cross References
Table of Contents Generating
The Nunnery Works Ltd
Box 582
Chesterville, Ontario K0C 1H0
Canada
This document describes version 1.0 of the MSPANTOC document
processing utility.
The MSPANTOC program and this document are both (C) copyright
1987 by The Nunnery Works Ltd.
TABLE OF CONTENTS
1. INTRODUCTION . . . . . . . . . . . . . . . . . . . . 1-1
1.1. Purpose of This Manual . . . . . . . . . . . . . 1-1
1.2. Some Fine Print . . . . . . . . . . . . . . . . 1-1
1.3. Our Ownership, Your Rights . . . . . . . . . . . 1-1
1.4. MSPANTOC Overview . . . . . . . . . . . . . . . 1-3
1.4.1. Paragraph/Section Numbering . . . . . . . 1-3
1.4.2. Symbolic Cross References . . . . . . . . 1-3
1.4.3. Figure Numbering . . . . . . . . . . . . 1-3
1.4.4. Table Numbering . . . . . . . . . . . . . 1-3
1.4.5. Table of Contents . . . . . . . . . . . . 1-4
1.4.6. List of Figures . . . . . . . . . . . . . 1-4
1.4.7. List of Tables . . . . . . . . . . . . . 1-4
1.4.8. Format Options . . . . . . . . . . . . . 1-4
1.5. System Requirements . . . . . . . . . . . . . . 1-6
1.6. The Nunnery Works Ltd . . . . . . . . . . . . . 1-7
1.7. Why We Created MSPANTOC . . . . . . . . . . . . 1-7
1.8. Bugs, Comments and Suggestions . . . . . . . . . 1-8
1.9. Future Plans . . . . . . . . . . . . . . . . . . 1-9
1.9.1. Exported Symbols . . . . . . . . . . . . 1-9
1.9.2. Imported Symbols . . . . . . . . . . . . 1-9
1.9.3. Run Time Format Changes . . . . . . . . . 1-10
1.10. How To Become a Registered User . . . . . . . . 1-11
1.10.1. As a Personal User . . . . . . . . . . 1-11
1.10.2. As a Corporate or Government User . . . 1-12
1.10.3. For a Site License . . . . . . . . . . 1-12
1.11. Registration Form . . . . . . . . . . . . . . . 1-13
2. INSTALLATION . . . . . . . . . . . . . . . . . . . . 2-1
2.1. Introduction . . . . . . . . . . . . . . . . . . 2-1
2.2. Make a Back Up Copy . . . . . . . . . . . . . . 2-1
2.3. Distributed Files . . . . . . . . . . . . . . . 2-1
2.3.1. MSP10.DOC . . . . . . . . . . . . . . . . 2-1
2.3.2. MSP10.EXE . . . . . . . . . . . . . . . . 2-1
2.3.3. MSP.CFG . . . . . . . . . . . . . . . . . 2-2
2.3.4. MSPC10.EXE . . . . . . . . . . . . . . . 2-2
2.3.5. WS.ATR . . . . . . . . . . . . . . . . . 2-2
2.3.6. WP.ATR . . . . . . . . . . . . . . . . . 2-2
3. PREPARING A DOCUMENT . . . . . . . . . . . . . . . . 3-1
3.1. Introduction . . . . . . . . . . . . . . . . . . 3-1
3.2. Document Preparation Summary . . . . . . . . . . 3-1
3.3. Creating a Document . . . . . . . . . . . . . . 3-1
3.3.1. Justification . . . . . . . . . . . . . . 3-2
3.3.2. Page Numbering . . . . . . . . . . . . . 3-2
3.3.3. Page Breaks . . . . . . . . . . . . . . . 3-3
3.4. Our Chapter File Organization . . . . . . . . . 3-3
3.5. MSPANTOC Requests . . . . . . . . . . . . . . . 3-4
3.5.1. Lead-in String . . . . . . . . . . . . . 3-4
3.5.2. Request Code . . . . . . . . . . . . . . 3-4
3.5.3. Symbol Name . . . . . . . . . . . . . . . 3-5
TABLE OF CONTENTS
3.6. Request Codes in Detail . . . . . . . . . . . . 3-7
3.6.1. *n - Assign a Paragraph Number . . . . . 3-7
3.6.2. #n - Assign a Section Number . . . . . . 3-7
3.6.3. F - Assign a Figure Number . . . . . . . 3-8
3.6.4. T - Assign a Table Number . . . . . . . . 3-9
3.6.5. @ - Request Current Chapter Number . . . 3-9
3.6.6. ? - Request a Paragraph Number . . . . . 3-10
3.6.7. P - Request a Page Number . . . . . . . . 3-10
4. CONFIGURING MSPANTOC . . . . . . . . . . . . . . . . 4-1
4.1. Introduction . . . . . . . . . . . . . . . . . . 4-1
4.2. Operation Summary . . . . . . . . . . . . . . . 4-1
4.2.1. Command Line . . . . . . . . . . . . . . 4-1
4.2.2. Input Configuration File . . . . . . . . 4-1
4.2.3. Attribute File . . . . . . . . . . . . . 4-1
4.2.4. Output Configuration File . . . . . . . . 4-2
4.3. Running MSPC . . . . . . . . . . . . . . . . . . 4-3
4.4. Creating an Attribute File . . . . . . . . . . . 4-3
4.5. Displayed Messages . . . . . . . . . . . . . . . 4-4
4.5.1. Status Messages . . . . . . . . . . . . . 4-4
4.5.2. Error Messages . . . . . . . . . . . . . 4-5
4.6. Configuration Options . . . . . . . . . . . . . 4-8
4.6.1. Main Menu . . . . . . . . . . . . . . . . 4-8
4.6.2. Table of Contents Menu . . . . . . . . . 4-10
4.6.3. Figures menu . . . . . . . . . . . . . . 4-14
4.6.4. Tables menu . . . . . . . . . . . . . . 4-17
4.6.5. Document format menu, part 1 . . . . . . 4-20
4.6.6. Document format menu, part 2 . . . . . . 4-22
4.6.7. Document format menu, part 3 . . . . . . 4-24
4.6.8. Miscellaneous menu . . . . . . . . . . . 4-25
5. RUNNING MSPANTOC . . . . . . . . . . . . . . . . . . 5-1
5.1. Introduction . . . . . . . . . . . . . . . . . . 5-1
5.2. Command Line Format . . . . . . . . . . . . . . 5-1
5.2.1. Control File . . . . . . . . . . . . . . 5-1
5.2.2. Configuration File . . . . . . . . . . . 5-2
5.3. Command Line Examples . . . . . . . . . . . . . 5-2
5.4. Displayed Messages . . . . . . . . . . . . . . . 5-3
5.4.1. Status Messages . . . . . . . . . . . . . 5-3
5.4.2. Error Messages . . . . . . . . . . . . . 5-3
5.5. Processing Summary . . . . . . . . . . . . . . . 5-7
5.5.1. Command Line . . . . . . . . . . . . . . 5-7
5.5.2. Control File . . . . . . . . . . . . . . 5-7
5.5.3. Configuration File . . . . . . . . . . . 5-7
5.5.4. Input Text Files . . . . . . . . . . . . 5-7
5.5.5. Table of Contents File . . . . . . . . . 5-8
5.5.6. List of Figures File . . . . . . . . . . 5-8
5.5.7. List of Tables File . . . . . . . . . . . 5-8
5.5.8. Output Text Files . . . . . . . . . . . . 5-8
TABLE OF CONTENTS
6. PRINTING A DOCUMENT . . . . . . . . . . . . . . . . . 6-1
6.1. Introduction . . . . . . . . . . . . . . . . . . 6-1
6.2. After MSPANTOC Runs . . . . . . . . . . . . . . 6-1
6.3. A General Solution . . . . . . . . . . . . . . . 6-1
6.4. Using WordStar with MailMerge . . . . . . . . . 6-2
6.5. Using WordStar without MailMerge . . . . . . . . 6-2
6.6. Using WordPerfect . . . . . . . . . . . . . . . 6-3
LIST OF FIGURES
Figure 3-1 Sample Multi-Level Numbers . . . . . . . . 3-5
Figure 4-1 MSPC Operation Summary . . . . . . . . . . 4-2
Figure 4-2 Main Menu . . . . . . . . . . . . . . . . 4-9
Figure 4-3 Table of Contents Menu . . . . . . . . . . 4-12
Figure 4-4 Table of Contents, With Indentation . . . 4-13
Figure 4-5 Table of Contents, No Indentation . . . . 4-13
Figure 4-6 Table of Contents, Lowest Level Only . . . 4-13
Figure 4-7 Figures Menu . . . . . . . . . . . . . . . 4-16
Figure 4-8 Tables Menu . . . . . . . . . . . . . . . 4-19
Figure 4-9 Document Menu, Part 1 . . . . . . . . . . 4-21
Figure 4-10 Document Menu, Part 2 . . . . . . . . . . 4-21
Figure 4-11 Table of Contents, Differing Number Syste 4-23
Figure 4-12 Document Menu, Part 3 . . . . . . . . . . 4-26
Figure 4-13 Miscellaneous Values Menu . . . . . . . . 4-26
Figure 5-1 MSPANTOC Processing Summary . . . . . . . 5-9
MSPANTOC Version 1.0 INTRODUCTION
1. INTRODUCTION 1. INTRODUCTION _______________
1.1. Purpose of This Manual 1.1. Purpose of This Manual
This manual describes MSPANTOC, version 1.0. MSPANTOC is a
document processing utility for MS-DOS and PC-DOS that
1) numbers sections, paragraphs, figures and tables
2) resolves symbolic cross references to section, paragraph,
figure and table numbers
3) creates a table of contents, a list of figures and a list
of tables.
This chapter presents an overview of MSPANTOC and describes the
ownership and licensing conditions.
1.2. Some Fine Print 1.2. Some Fine Print
MailMerge is a registered trademark of MicroPro International
Corporation.
MS-DOS is a registered trademark of Microsoft Corporation.
PC-DOS is a registered trademark of IBM Corporation.
StarIndex is a trademark of MicroPro International Corporation.
WordPerfect is a registered trademark of WordPerfect Corporation.
WordStar is a registered trademark of MicroPro International
Corporation
1.3. Our Ownership, Your Rights 1.3. Our Ownership, Your Rights
The MSPANTOC program and this manual are both the copyrighted
property of The Nunnery Works Ltd.
We are distributing this program as user-supported software.
This does not mean that we are releasing MSPANTOC into the public
domain. Instead, we are retaining all rights to the program and
its documentation.
We grant you a limited license to use MSPANTOC for your personal
evaluation purposes.
Copyright (C) The Nunnery Works Ltd 1987 Page 1-1
MSPANTOC Version 1.0 INTRODUCTION
We encourage you to copy and to distribute the MSPANTOC program
and documentation, subject to the following conditions:
1) Any fee you charge for copying or distributing
MSPANTOC is to cover your handling and media costs.
This fee does not give the person who receives the
copy any rights with respect to MSPANTOC other than
those stated above.
2) All distributed copies of the MSPANTOC program and
documentation, excluding the distribution media, remain
the property of The Nunnery Works Ltd.
3) You may distribute MSPANTOC only in its original and
unmodified state.
After you have evaluated MSPANTOC and if you find it useful, we
ask you and any to whom you distribute the MSPANTOC program to
become registered users. To register, fill in the registration
request form and return it to us along with the appropriate
registration fee for your location. See section 1.10 on page
1-11 for details.
Please note that we accept corporate and government purchase
orders. See section 1.10.2 for details.
We will be happy to provide a site license to corporate or
government users. Please write for details.
Your registration helps us by providing the funds to further
extend MSPANTOC.
If you become a registered user, we will:
1) Send you a receipt for your registration fee
2) Send you a copy of the most recent version of the
program.
3) Send you the next major update, free of additional
charge.
4) Notify you of significant updates which will be available
at minimal charge.
Copyright (C) The Nunnery Works Ltd 1987 Page 1-2
MSPANTOC Version 1.0 INTRODUCTION
1.4. MSPANTOC Overview 1.4. MSPANTOC Overview
MSPANTOC is not a word processing program and it is not an
outline processor. It reads a document you create with your
favorite word processing package and writes a new document,
updated with
1) assigned section, paragraph, figure and table numbers,
2) resolved cross references
3) a table of contents
4) a list of figures
5) a list of tables.
1.4.1. Paragraph/Section Numbering 1.4.1. Paragraph/Section Numbering
MSPANTOC sequentially numbers the paragraphs or sections that you
identify and creates multi-level paragraph or section numbers,
like 3.2.1.5.
1.4.2. Symbolic Cross References 1.4.2. Symbolic Cross References
MSPANTOC resolves symbolic section, paragraph, figure and table
number cross references. It allows you to enter in your document
a phrase such as "refer to paragraph =>?alloy_desc for a full
description of the alloy contents." The output file that
MSPANTOC creates will contain the full section, paragraph, figure
or table number associated with the symbol "alloy_desc".
1.4.3. Figure Numbering 1.4.3. Figure Numbering
MSPANTOC sequentially numbers figures that you identify and
creates figure numbers, like 3-5, according to a format you
specify.
1.4.4. Table Numbering 1.4.4. Table Numbering
MSPANTOC sequentially numbers tables that you identify and
creates table numbers, like 7-2, according to a format you
specify.
Copyright (C) The Nunnery Works Ltd 1987 Page 1-3
MSPANTOC Version 1.0 INTRODUCTION
1.4.5. Table of Contents 1.4.5. Table of Contents
MSPANTOC automatically creates a file containing a formatted
table of contents. The table of contents includes the section
numbers, section headings and page numbers.
1.4.6. List of Figures 1.4.6. List of Figures
MSPANTOC automatically creates a file containing a formatted list
of the figures you identify in your document. The list of
figures includes the figure numbers, figure descriptions and page
numbers.
1.4.7. List of Tables 1.4.7. List of Tables
MSPANTOC automatically creates a file containing a formatted list
of the tables you identify in your document. The list of tables
includes the table numbers, table descriptions and page numbers.
1.4.8. Format Options 1.4.8. Format Options
MSPANTOC provides extensive control over the appearance of the
document it creates and allows the following display format
options:
1.4.8.1. Number Level Format
MSPANTOC will display each level of a paragraph or section number
in one of 5 formats:
1) Arabic numbers (1, 2, 3, ...),
2) upper case Roman numerals (I, II, III, IV, ...),
3) lower case Roman numerals (i, ii, iii, iv, ...),
4) upper case alphabetics (A, B, C, ...) or
5) lower case alphabetics (a, b, c, ...).
Copyright (C) The Nunnery Works Ltd 1987 Page 1-4
MSPANTOC Version 1.0 INTRODUCTION
1.4.8.2. Print Attributes
MSPANTOC can include the specific codes that your word processing
package uses to select print attributes such as bold, underlined,
italics etc. to control the printed appearance of the following
items:
1) section headings, by level, in the table of contents
2) section headings, by level, in the main document
3) figure descriptions in the main document
4) table descriptions in the main document
1.4.8.3. Level Number Punctuation
MSPANTOC allows you to specify the punctuation inserted after
each level of a multi-level section or paragraph number. For
example, MSPANTOC will display a number with (strange ?)
punctuation like 3-4.2#a) if you request it.
1.4.8.4. Page Number Format
MSPANTOC will number pages either sequentially (1, 2, 3, ...) or
sequentially within chapter number (1-1, 1-2, ..., 2-1, ...).
1.4.8.5. Figure Number Format
MSPANTOC will number figures either sequentially (1, 2, 3, ...)
or sequentially within chapter number (1-1, 1-2, ..., 2-1, ...).
1.4.8.6. Table Number Format
MSPANTOC will number tables either sequentially (1, 2, 3, ...) or
sequentially within chapter number (1-1, 1-2, ..., 2-1, ...).
Copyright (C) The Nunnery Works Ltd 1987 Page 1-5
MSPANTOC Version 1.0 INTRODUCTION
1.5. System Requirements 1.5. System Requirements
The Nunnery Works Ltd specifically designed MSPANTOC to operate
on any MS-DOS or PC-DOS system. MSPANTOC does not use any
specific IBM PC hardware feature (graphics, ports, disks etc) and
should work on any system that runs MS-DOS or PC-DOS with version
numbers of 2.xx or higher.
The minimum system requirements are:
1) a system that runs MS-DOS or PC-DOS 2.xx or higher
2) 128k of memory
3) at least one floppy disk drive
However, we recommend that you use a system that includes a hard
disk.
Copyright (C) The Nunnery Works Ltd 1987 Page 1-6
MSPANTOC Version 1.0 INTRODUCTION
1.6. The Nunnery Works Ltd 1.6. The Nunnery Works Ltd
The Nunnery Works Ltd is a consulting company located in
Chesterville, Ontario, a small farming community about 40 miles
southeast of Ottawa. Our founder lives in a house that was used
as a convent for 50 years, thus, our name.
1.7. Why We Created MSPANTOC 1.7. Why We Created MSPANTOC
Much of our work involves technical writing - proposals, bids or
general documentation that requires multi-level paragraph and
section numbering.
In our environment, these types of documents are written by
multiple authors, require frequent re-organization and
renumbering and require extensive cross references.
We created our first version of what evolved into MSPANTOC in
1975 for use in a mini computer environment. We later
implemented versions for different environments but not for MS-
DOS or PC-DOS.
We tried StarIndex when we were using WordStar but StarIndex
supports only 4 levels of numbering and does not provide a
symbolic referencing feature to solve our requirements for
automatic cross references.
We also tried WordPerfect but did not like the requirement to
indent to create new sub-levels and WordPerfect also does not
provide symbolic referencing.
So, because we could not locate a commercial product that met our
requirements, we decided to implement our existing program under
MS-DOS.
Copyright (C) The Nunnery Works Ltd 1987 Page 1-7
MSPANTOC Version 1.0 INTRODUCTION
1.8. Bugs, Comments and Suggestions 1.8. Bugs, Comments and Suggestions
We have been in the design and programming business a long time
and we have not yet built a program of any size that did not
contain some surprise bugs. We do not expect that MSPANTOC will
be any different.
If and when you discover any obvious problems or anything at all
that does not seem to operate the way the documentation states it
should, please inform us by mail and we will correct the problems
as soon as possible and return an updated version of the program
to you.
We are particularly interested in making MSPANTOC compatible with
as many word processing packages as possible. If any MSPANTOC
features do not work with your word processing package, please
let us know.
It is our intent that MSPANTOC operates as documented, is bug
free and performs a useful function.
If you have any comments or suggestions for enhancements, please
write us and pass them on. Wherever possible, we will continue
to extend the program to make it even more useful. If we can
implement any of your suggestions, we will send you a new version
of the program that includes the changes you suggested.
Copyright (C) The Nunnery Works Ltd 1987 Page 1-8
MSPANTOC Version 1.0 INTRODUCTION
1.9. Future Plans 1.9. Future Plans
Future versions of MSPANTOC will include at least the following
new features:
1.9.1. Exported Symbols 1.9.1. Exported Symbols
A future version of MSPANTOC will allow you to specify a file
name where it will output the symbols defined in the current
document.
For each symbol, MSPANTOC will output the following:
1) the symbol name
2) the page number where the symbol is defined
3) the page number format
4) the section, paragraph, figure or table number
associated with the symbol
5) the number display format in effect at the time the
symbol was defined
1.9.2. Imported Symbols 1.9.2. Imported Symbols
A future version of MSPANTOC will allow you to specify one or
more file names from which it will obtain full information about
symbols defined in some other documents.
For each symbol, MSPANTOC will read the following:
1) the symbol name
2) the page number where the symbol is defined
3) the page number format
4) the section, paragraph, figure or table number
associated with the symbol
5) the number display format in effect at the time the
symbol was defined
This feature will allow the user to make symbolic cross
references into other documents. In addition, MSPANTOC will
resolve these cross references using the number display formats
used in the other documents. These formats could be different
from the formats being used in the current document.
Copyright (C) The Nunnery Works Ltd 1987 Page 1-9
MSPANTOC Version 1.0 INTRODUCTION
1.9.3. Run Time Format Changes 1.9.3. Run Time Format Changes
A future version of MSPANTOC will allow you to select and change
from within your document the display format, by level, for
section and paragraph numbers.
This feature will allow MSPANTOC to generate, for example, a 3
level section number like 3.7.12 in one part of the document and
other numbers like 5.2.a) or 5.3.iv) in another part.
Copyright (C) The Nunnery Works Ltd 1987 Page 1-10
MSPANTOC Version 1.0 INTRODUCTION
1.10. How To Become a Registered User 1.10. How To Become a Registered User
We encourage you to register as a user of MSPANTOC. You can
register as a user (personal, corporate or government) of one or
more copies and we also offer site licenses.
If you become a registered user, we will:
1) Send you a receipt for your registration fee
2) Send you a copy of the most recent version of the
program, licensed for use on a single computer.
3) Send you the next major update, free of additional
charge.
4) Notify you of significant updates which will be available
at minimal charge.
In all cases, our address is
The Nunnery Works Ltd
Box 582
Chesterville, Ontario K0C 1H0
Canada
1.10.1. As a Personal User 1.10.1. As a Personal User
To register as a personal user of MSPANTOC, fill in the
registration form on the following page and return it along with
the appropriate registration fee to The Nunnery Works Ltd.
The registration fee is as follows:
1) For residents of Ontario, $37.14, Canadian funds
($35.00 + $2.14 sales tax)
2) For the rest of Canada, $35.00, Canadian funds
3) For the rest of the world, $35.00, US funds.
Copyright (C) The Nunnery Works Ltd 1987 Page 1-11
MSPANTOC Version 1.0 INTRODUCTION
1.10.2. As a Corporate or Government User 1.10.2. As a Corporate or Government User
To register as a corporate or government user of a single copy of
MSPANTOC, send a purchase order to The Nunnery Works Ltd.
Each copy of MSPANTOC will be licensed for use on a single
computer.
The registration fee for each copy is as follows:
1) For Ontario addresses, $37.14, Canadian funds
($35.00 + $2.14 provincial sales tax)
2) For the rest of Canada, $35.00, Canadian funds
3) For the rest of the world, $35.00, US funds.
Our terms for purchase orders are net 15.
1.10.3. For a Site License 1.10.3. For a Site License
We will be pleased to license your site for the use of multiple
copies of MSPANTOC. For details, write to
The Nunnery Works Ltd
Box 582
Chesterville, Ontario K0C 1H0
Canada
Copyright (C) The Nunnery Works Ltd 1987 Page 1-12
MSPANTOC Version 1.0 INTRODUCTION
1.11. Registration Form 1.11. Registration Form
Mail to: The Nunnery Works Ltd
Box 582
Chesterville, Ontario K0C 1H0
Canada
Please send me ________ registered copies of MSPANTOC.
Registration fee ($35.00 each copy) _________ . ______
Sales tax, Ontario residents only
($2.14 for each copy) _________ . ______
Total enclosed, cheque or money order
payable to The Nunnery Works Ltd _________ . ______
Name: ___________________________________
Address: ___________________________________
City: __________________
Prov/State: _____________ Postal/Zip Code: _______________
Country: ________________
Telephone: (______) ______ - ____________
MSPANTOC Serial Number from your current copy: __________
Your word processing package: _____________________________
Your operating system (please circle one) MS-DOS or PC-DOS
Comments:
Copyright (C) The Nunnery Works Ltd 1987 Page 1-13
MSPANTOC Version 1.0 INSTALLATION
2. INSTALLATION 2. INSTALLATION _______________
2.1. Introduction 2.1. Introduction
This chapter describes the various files distributed as part of
the MSPANTOC package.
2.2. Make a Back Up Copy 2.2. Make a Back Up Copy
Before using MSPANTOC, we recommend that you make a copy of the
distributed files, save your original copy and then work from
your copy.
Use the following procedure to make a copy of the MSPANTOC
distribution files.
1. Insert your system diskette in drive A and enter the
following command:
>A:DISKCOPY A: B:
2. Insert the diskette containing the MSPANTOC
distribution files in drive A and a formatted diskette
in drive B and then press the RETURN or ENTER key.
This procedure copies the distributed MSPANTOC files to a new
diskette in drive B. When the copy operation completes, save the
original diskette from drive A and retain the copy from drive B
as your working copy.
2.3. Distributed Files 2.3. Distributed Files
The Nunnery Works Ltd distributes MSPANTOC, version 1.0, on a
single diskette containing the following files.
2.3.1. MSP10.DOC 2.3.1. MSP10.DOC
This file is the MSPANTOC, version 1.0 documentation file.
2.3.2. MSP10.EXE 2.3.2. MSP10.EXE
This file is the MSPANTOC, version 1.0 executable program.
Copyright (C) The Nunnery Works Ltd 1987 Page 2-1
MSPANTOC Version 1.0 INSTALLATION
2.3.3. MSP.CFG 2.3.3. MSP.CFG
This file is the MSPANTOC, version 1.0, default configuration
file.
2.3.4. MSPC10.EXE 2.3.4. MSPC10.EXE
This file is the MSPANTOC, version 1.0, executable configuration
program.
2.3.5. WS.ATR 2.3.5. WS.ATR
This file is the default print attribute file for use with
WordStar.
The MSPANTOC configuration program reads this file and includes
its contents in the configuration file.
2.3.6. WP.ATR 2.3.6. WP.ATR
This file is the default print attribute file for use with
WordPerfect.
The MSPANTOC configuration program reads this file and includes
its contents in the configuration file.
Copyright (C) The Nunnery Works Ltd 1987 Page 2-2
MSPANTOC Version 1.0 INSTALLATION
Copyright (C) The Nunnery Works Ltd 1987 Page 2-3
MSPANTOC Version 1.0 PREPARING A DOCUMENT
3. PREPARING A DOCUMENT 3. PREPARING A DOCUMENT _______________________
3.1. Introduction 3.1. Introduction
This chapter describes how to use MSPANTOC to number sections,
paragraphs, figures or tables and to cross reference to other
parts of your document.
3.2. Document Preparation Summary 3.2. Document Preparation Summary
The following steps summarize the work you must do to prepare a
document for processing by MSPANTOC. These steps are usually
done in parallel but it is obviously easier to present them as a
list of separate items.
1) Create a document using your word processing package.
2) Identify any sections to be numbered and included in
the table of contents and include an MSPANTOC section
number request for each one.
3) Identify any paragraphs to be numbered and include an
MSPANTOC paragraph number request for each one.
4) Identify any figures or tables to be numbered and include
an MSPANTOC figure or table number request for each one.
5) Identify any sections, paragraphs, figures or tables that
must be referenced elsewhere within the document and
assign a unique symbol to each.
6) Identify any locations in your document which must
reference by number or page number a section, paragraph,
figure or table located elsewhere within the document and
include an MSPANTOC cross reference request for each one.
3.3. Creating a Document 3.3. Creating a Document
Prepare your document using your favorite word processing
package. We suggest that you organize your document so that each
chapter occupies a separate file. This method simplifies the
problems of adding, deleting or changing the order of the
chapters but it works only with a word processing package that
can merge separate files together for printing as a single
document. Both WordStar and WordPerfect will do this.
Within each file, the only areas that might be different from
your normal procedures are document justification, page numbering
and page breaks.
Copyright (C) The Nunnery Works Ltd 1987 Page 3-1
MSPANTOC Version 1.0 PREPARING A DOCUMENT
3.3.1. Justification 3.3.1. Justification
If you intend to cross reference paragraph numbers using
MSPANTOC symbolic references, a document formatted with ragged
right margins (no right justification) will work best.
MSPANTOC does not reformat your paragraphs when it makes text
replacements. Anywhere it replaces a cross reference request of
the form "=>?symbol" with a paragraph number of different length
such as 1.3, the right margin will not be justified.
3.3.2. Page Numbering 3.3.2. Page Numbering
If you want pages numbered in a strictly sequential format from
beginning to end of your document, there should be no problem.
You can use your word processing package to place the page
numbers anywhere on the page.
If you want pages numbered sequentially within chapters with the
page number resetting to 1 at the start of each chapter, proceed
as follows:
1) Select the MSPANTOC configuration option to number pages
within chapters. This option directs MSPANTOC to create
the table of contents and page number cross references
with the correct format page numbers.
2) At the beginning of each chapter, insert the command for
your word processing package to reset the page number to
1.
3) Request that your word processor number the pages
somewhere other than in a page header. A page footing
is an ideal place. Insert a footer definition in each
chapter and position the footer definition after the
=>#1 that defines the new chapter number and heading.
4) Wherever you want the page number to appear, insert the
MSPANTOC chapter number request (=>@) before the page
number.
In WordStar, insert something like
... Page =>@-#
and WordStar will replace the # with the current page
number within the chapter to create a line that looks
like
... Page 12-3
Copyright (C) The Nunnery Works Ltd 1987 Page 3-2
MSPANTOC Version 1.0 PREPARING A DOCUMENT
In WordPerfect, insert something like
... Page =>@-^N
and WordPerfect will replace the ^N (control-N) with
the current page number within the chapter to create
a line that looks like
... Page 7-15
3.3.3. Page Breaks 3.3.3. Page Breaks
If MSPANTOC is to produce a usable table of contents, list of
figures and list of tables, you must control page breaks
manually. Wherever you require page breaks in a document, insert
an unconditional form feed. We designed MSPANTOC to work with
documents created by any word processing package. The only
universal method of detecting where page breaks occur is to
accept form feeds only.
WordStar inserts a form feed at the cursor location in a document
when you type ^PL (control-P L).
WordPerfect inserts a form feed at the cursor location in a
document when you type ^ENTER (control-ENTER).
3.4. Our Chapter File Organization 3.4. Our Chapter File Organization
As a guide for you, the following list shows the order in which
we position items in our individual chapter files.
1) Margin settings for the chapter.
2) Pitch setting for the chapter.
3) Header definition for the chapter.
4) A form feed.
5) The chapter section heading (=>#1 heading).
6) A command to set the page number to 1.
7) Footing definition for the chapter, including the page
number in the footing.
8) The chapter text.
Copyright (C) The Nunnery Works Ltd 1987 Page 3-3
MSPANTOC Version 1.0 PREPARING A DOCUMENT
3.5. MSPANTOC Requests 3.5. MSPANTOC Requests
All MSPANTOC requests consist of 2 mandatory items:
1) a lead-in string
2) a 1 or 2 character request code
and some requests require or allow the addition of another item:
3) a symbol name
3.5.1. Lead-in String 3.5.1. Lead-in String
A lead-in string is a predefined sequence of from 1 to 3
characters which identify for MSPANTOC (and visually highlight)
the next 1 or 2 characters as an action request code.
The configuration file on the MSPANTOC distribution diskette
defines the 2 character string => as the default lead-in string.
Refer to section 4.6.8.2 on page 4-25 for a description of how to
use the MSPANTOC configuration program to change the lead-in
string.
3.5.2. Request Code 3.5.2. Request Code
The request code is 1 or 2 characters and identifies a request to
MSPANTOC for either
1) the assignment of a new paragraph, section, figure
or table number
2) the retrieval of a page, chapter, section, paragraph,
figure or table number defined elsewhere in the
document.
The request code can be one of the following:
*n - Assign a level n paragraph number
#n - Assign a level n section number
F - Assign a figure number
T - Assign a table number
@ - Request the current chapter number
? - Request a paragraph number
P - Request a page number
Copyright (C) The Nunnery Works Ltd 1987 Page 3-4
MSPANTOC Version 1.0 PREPARING A DOCUMENT
A paragraph or section number request includes a single digit in
the range 1-9. This digit defines the paragraph or section level
number to assign. For example, the figure 3-1 lists sample
paragraph or section numbers that MSPANTOC assigns for each
level.
__________________________________________________________
Level Sample Section or Paragraph Number
1 1.
2 1.2.
3 1.2.3.
4 1.2.3.4.
5 1.2.3.4.5.
6 1.2.3.4.5.6.
7 1.2.3.4.5.6.7.
8 1.2.3.4.5.6.7.8.
9 1.2.3.4.5.6.7.8.9.
Figure 3-1: Sample Multi-Level Numbers
__________________________________________________________
3.5.3. Symbol Name 3.5.3. Symbol Name
A symbol name can follow the number assignment request codes (*n,
#n, F and T). MSPANTOC saves the symbol name along with
1) the full multi-level assigned number (section, paragraph,
figure or table)
2) the page number where the symbol is defined
A symbol name must follow the request codes ? and P. MSPANTOC
replaces the lead-in string, request code and the symbol name
with either the full multi-level assigned number (?) or page
number (P) that was saved with the symbol name.
A symbol name consists of from 1 to 10 characters. If a symbol
name has more than 10 characters, MSPANTOC uses only the first
10.
Copyright (C) The Nunnery Works Ltd 1987 Page 3-5
MSPANTOC Version 1.0 PREPARING A DOCUMENT
Each character in a symbol name can be chosen from the following
groups:
1) alphabetic characters, A-Z, a-z
2) numeric characters, 0-9
3) the 2 special characters, - (dash or minus sign) and
_ (underline)
MSPANTOC considers a symbol name to end with the first occurrence
of a character that does not belong to one of the above groups.
MSPANTOC converts all symbol names to upper case. Thus, upper
and lower case letters are equivalent and cannot be used to
differentiate symbols.
Copyright (C) The Nunnery Works Ltd 1987 Page 3-6
MSPANTOC Version 1.0 PREPARING A DOCUMENT
3.6. Request Codes in Detail 3.6. Request Codes in Detail
The following sections describe the individual request codes in
more detail.
3.6.1. *n - Assign a Paragraph Number 3.6.1. *n - Assign a Paragraph Number
Use the *n request to number a paragraph without creating a table
of contents entry.
MSPANTOC increments the current level n number, clears all level
numbers lower than n and leaves level numbers higher than n
unchanged. Level 1 is the highest level (chapter) number and
level 9 is the lowest level number.
MSPANTOC replaces the lead-in string and 2 character request code
with the full n-level paragraph number.
For example, if a document contains
=>*3 This is an example of a paragraph number assignment
with no need for a table of contents entry.
after MSPANTOC processes the document, the output file will
contain a line with the form
2.3.4. This is an example of a paragraph number ...
3.6.2. #n - Assign a Section Number 3.6.2. #n - Assign a Section Number
Use the #n request to number a section and create an entry in the
table of contents.
MSPANTOC increments the current level n number, clears all level
numbers lower than n and leaves level numbers higher than n
unchanged. Level 1 is the highest level (chapter) number and
level 9 is the lowest level number.
MSPANTOC replaces the lead-in string and 2 character request code
with the full n-level section number.
MSPANTOC adds the line containing the section number definition
to the table of contents.
Copyright (C) The Nunnery Works Ltd 1987 Page 3-7
MSPANTOC Version 1.0 PREPARING A DOCUMENT
For example, if a document contains
=>#1 INTRODUCTION
after MSPANTOC processes the document, the output file will
contain a line with the form
2. INTRODUCTION
and the table of contents will include an entry with the assigned
section number (2.), heading text (INTRODUCTION) and current page
number.
3.6.3. F - Assign a Figure Number 3.6.3. F - Assign a Figure Number
Use the F request to number a figure and create an entry in the
list of figures. MSPANTOC accepts the request code in either
upper (F) or lower (f) case.
MSPANTOC increments the current figure number and replaces the
lead-in string and request code (=>F) with the figure caption
(see section 4.6.3.4 on page 4-15 for a description of how to
change the figure caption) followed by the figure number.
MSPANTOC adds the line containing the figure number definition to
the list of figures.
For example, if a document contains
=>F Summary Report Example
and the current figure caption value is Figure, after MSPANTOC
processes the document, the output file will contain a line with
the form
Figure 5-2: Summary Report Example
and the list of figures will include an entry with the figure
caption (Figure), assigned figure number (5-2), figure title
(Summary Report Example) and current page number.
Copyright (C) The Nunnery Works Ltd 1987 Page 3-8
MSPANTOC Version 1.0 PREPARING A DOCUMENT
3.6.4. T - Assign a Table Number 3.6.4. T - Assign a Table Number
Use the T request to number a table and create an entry in the
list of tables. MSPANTOC accepts the request code in either
upper (T) or lower (t) case.
MSPANTOC increments the current table number and replaces the
lead-in string and request code (=>T) with the table caption (see
section 4.6.4.4 on page 4-18 for a description of how to change
the table caption) followed by the table number.
MSPANTOC adds the line containing the table number definition to
the list of tables.
For example, if a document contains
=>T Revenues by Region
and the current table caption value is Table, after MSPANTOC
processes the document, the output file will contain a line with
the form
Table 3-9: Revenues by Region
and the list of tables will include an entry with the table
caption (Table), assigned table number (3-9), table title
(Revenues by Region) and current page number.
3.6.5. @ - Request Current Chapter Number 3.6.5. @ - Request Current Chapter Number
Use the @ request in page footing definitions or anywhere else
you want the current chapter number to appear.
MSPANTOC replaces the lead-in string and request code (=>@) with
the current value of the level 1 number, the chapter number.
For example, if a document contains
Page =>@-3 ...
and the current chapter number is 6, after MSPANTOC processes the
document, the output file will contain the following line
Page 6-3 ...
Copyright (C) The Nunnery Works Ltd 1987 Page 3-9
MSPANTOC Version 1.0 PREPARING A DOCUMENT
3.6.6. ? - Request a Paragraph Number 3.6.6. ? - Request a Paragraph Number
Use the ? request to cross reference to a symbolic section,
paragraph, figure or table number.
MSPANTOC searches its symbol table for the symbol name that
follows the request code. If it finds the symbol name, MSPANTOC
replaces the lead-in string, the request code and the symbol name
with the full multi-level paragraph, section, figure or table
number stored in the symbol table entry.
For example, if a document contains
... refer to paragraph =>?details
after MSPANTOC processes the document, the output file will
contain a line with the form
... refer to paragraph 4.2.7.
3.6.7. P - Request a Page Number 3.6.7. P - Request a Page Number
Use the P request to cross reference to a symbolic page number
for the beginning of a section, paragraph, figure or table.
MSPANTOC accepts the request code in either upper (P) or lower
(p) case.
MSPANTOC searches its symbol table for the symbol name that
follows the request code. If it finds the symbol name, MSPANTOC
replaces the lead-in string, the request code and the symbol name
with the page number stored in the symbol table entry.
For example, if a document contains
... refer to paragraph =>?summary on page =>Psummary.
after MSPANTOC processes the document, the output file will
contain a line with the form
... refer to paragraph 2.9.12 on page 2-46.
Copyright (C) The Nunnery Works Ltd 1987 Page 3-10
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4. CONFIGURING MSPANTOC 4. CONFIGURING MSPANTOC _______________________
4.1. Introduction 4.1. Introduction
This chapter describes the operation of the MSPANTOC
configuration program, MSPC. It describes the command line
format, the configuration options and the error messages and
summarizes the operation of the program.
4.2. Operation Summary 4.2. Operation Summary
Figure 4-1 on page 4-2 summarizes the operation of MSPC.
MSPC reads all files on the left side of the figure and creates
the files on the right side.
4.2.1. Command Line 4.2.1. Command Line
MSPC obtains the pathnames of the optional input configuration
file and the optional attribute file from the command line you
enter.
4.2.2. Input Configuration File 4.2.2. Input Configuration File
If you specify an input configuration file, MSPC reads this file
to obtain the current settings of all user settable values. MSPC
then allows you to update these values and save the new values
back to another disk file.
If the command line does not contain a configuration file name,
MSPC uses an internally defined set of default values as a
starting point which you can update to meet your needs.
4.2.3. Attribute File 4.2.3. Attribute File
MSPC reads the print attribute file to obtain the control
character strings that your word processing package uses to
identify portions of text to print using special formatting
attributes. These attributes include, for example, bold print,
italic print, emphasized print, underlined print etc.
Copyright (C) The Nunnery Works Ltd 1987 Page 4-1
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.2.4. Output Configuration File 4.2.4. Output Configuration File
MSPC gives you the option of saving your configuration changes.
If you so choose, MSPC creates a new configuration file on disk
and saves your updated values in this file. MSPC gives you the
choice of file name.
__________________________________________________________
----------------
| |
Command Line -----> | |
| M |
| S |
| P |
Configuration File | C | Configuration File
| |
------------- | | -------------
| | | | | |
| |--> | | --> | |
| | | | | |
------------- | | -------------
| |
| |
Attribute File | |
| |
------------- | |
| | | |
| |--> | |
| | | |
------------- | |
| |
| |
----------------
Figure 4-1: MSPC Operation Summary
__________________________________________________________
Copyright (C) The Nunnery Works Ltd 1987 Page 4-2
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.3. Running MSPC 4.3. Running MSPC
To run the MSPANTOC configuration program, enter a command line
with the form
MSPC10 input-configuration-file/C attribute-file/A
where:
1) MSPC10 is the name of the MSPANTOC configuration
program, version 1.0
2) input-configuration-file is the full pathname of the
optional input configuration file
3) attribute-file is the full pathname of the optional
attribute file
4.4. Creating an Attribute File 4.4. Creating an Attribute File
Create the attribute file with your word processing package. The
attribute file consists of one or more lines that each end with a
hard carriage return or line feed.
Each line defines one print attribute and consists of
1) the control codes used to turn the attribute on
2) an arbitrarily chosen and unique single upper
case letter to identify the attribute
3) the control codes used to turn the attribute off
4) a hard carriage return or line feed.
For example, to enter the attribute file line to define the print
attribute bold, in general you would proceed as follows:
1) turn bold printing on
2) type a capital B
3) turn bold printing off
4) press carriage return (or ENTER)
Specifically, in WordStar, you would proceed as follows:
1) type ^PB (control-P then B)
2) type capital B
3) type ^PB (control-P then B)
4) press carriage return (or ENTER)
Copyright (C) The Nunnery Works Ltd 1987 Page 4-3
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
In WordPerfect, you would proceed as follows:
1) press BOLD-ON
2) type capital B
3) press BOLD-OFF
4) press carriage return (or ENTER)
Testing an attribute file is simple. Print the file using your
word processing package. If the single upper case letters print
with the attributes you intended, then the file is correct. If
the printed results are not correct, consult your word processing
documentation.
The MSPANTOC distribution files include WS.ATR and WP.ATR. These
files contain basic (bold and underline) attribute definitions
for WordStar and WordPerfect, respectively.
This section mentions only the bold and underline attributes but
MSPC and MSPANTOC will accept any print attributes that your word
processing package and printer combination can support.
4.5. Displayed Messages 4.5. Displayed Messages
MSPC displays 2 types of messages on the console display screen
while it is running, status messages and error messages.
The following 2 sections describe each of the possible status and
error messages that you might see.
4.5.1. Status Messages 4.5.1. Status Messages
4.5.1.1. Unable to open attribute file file-name
MS-DOS or PC-DOS reported an error while MSPC was trying to open
the named file for use as an attribute file. The named file
probably does not exist. MSPC assumes that you do not want any
attributes defined and continues execution after displaying the
following message:
Assuming no attributes wanted
Copyright (C) The Nunnery Works Ltd 1987 Page 4-4
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.5.2. Error Messages 4.5.2. Error Messages
4.5.2.1. Caption is too long. Max length is 99 characters
The figure or table caption you entered is too long. MSPC will
accept a caption with a length up to the specified maximum.
4.5.2.2. File f-n does not contain a usable copy of configuration
data
MSPC attempted to obtain configuration information from the file
named f-n in the message. This file does not contain a usable
copy of configuration data. Either the file was not previously
created by MSPC or it was created by an old version of MSPC.
4.5.2.3. File write error, file file-name
MS-DOS or PC-DOS reported an error while MSPC was trying to write
to the file named file-name in the message. This could be a
transient disk error that will go away if you retry or it could
be permanent. It could be caused because there is not enough
room on the disk drive or because you have a write protected
diskette.
4.5.2.4. Heading is too long. Max length is 99 characters
The table of contents, figure or table heading you entered is too
long. MSPC will accept a heading with a length up to the
specified maximum.
4.5.2.5. Input file read error, file file-name
MS-DOS or PC-DOS reported an error while MSPC was trying to read
from the file named file-name in the message. This could be a
transient disk error that will go away if you retry or it could
be permanent.
Copyright (C) The Nunnery Works Ltd 1987 Page 4-5
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.5.2.6. Invalid attribute code atr-code
MSPC has no definition for the named attribute code. Add a
definition of this code to your attribute file and rerun MSPC.
4.5.2.7. Invalid command line format
MSPC detected an error in the command line.
4.5.2.8. Minimum string length is 1 character
You attempted to specify a zero length lead-in string. MSPC
requires a lead-in string to be at least 1 character long.
4.5.2.9. Missing attribute type code
MSPC found a line in your attribute file that does not contain an
upper case letter it can consider to be the attribute code.
4.5.2.10. String is too long. Max length is 99 characters
You attempted to specify a lead-in string that is too long. MSPC
will accept a lead-in string with the specified maximum length.
4.5.2.11. Too many attributes
You specified too many print attributes for the current item.
MSPC will accept a maximum of 5 print attributes for any one
item.
4.5.2.12. Too many attributes in file file-name
The named attribute file contains too many attribute code
definitions. MSPC will accept a maximum of 15 individual
attributes.
Copyright (C) The Nunnery Works Ltd 1987 Page 4-6
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.5.2.13. Too many attribute lead-in characters
Your attribute file contains too many characters before the upper
case letter that defines the attribute code. The characters
before the attribute code should be the characters your word
processing package uses to turn the print attribute on. MSPC
will accept a maximum of 9 characters before the attribute code.
If your word processing package turns on a print attributes with
a string of more than 9 characters, please contact us.
4.5.2.14. Too many attribute lead-out characters for code X
Your attribute file contains too many characters after the
specified attribute code. The characters after the attribute
code should be the characters your word processing package uses
to turn the print attribute off. MSPC will accept a maximum of 9
characters after the attribute code. If your word processing
package turns off a print attributes with a string of more than 9
characters, please contact us.
4.5.2.15. Unable to read configuration data from file file-name
MS-DOS or PC-DOS reported an error while MSPC was trying to read
configuration data from the file named file-name in the message.
This could be a transient disk error that will go away if you
retry or it could be permanent.
4.5.2.16. Unable to open input configuration file file-name
MS-DOS or PC-DOS reported an error while MSPC was trying to open
the named configuration file. The named file probably does not
exist.
4.5.2.17. Unable to open output configuration file file-name
MS-DOS or PC-DOS reported an error while MSPC was trying to open
the named configuration file.
Copyright (C) The Nunnery Works Ltd 1987 Page 4-7
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6. Configuration Options 4.6. Configuration Options
MSPC interacts with the user through a series of menus. (PC-DOS
users will find these menus to be very unsophisticated visually
but they work on all MS-DOS computers.)
Select options from the menus by typing the single character
option, in either upper or lower case, and then pressing carriage
return (or ENTER).
4.6.1. Main Menu 4.6.1. Main Menu
Figure 4-2 on page 4-9 illustrates the contents of the MSPC main
menu.
The following paragraphs describe each of the main menu options.
4.6.1.1. A Table of contents menu
Select option A from the main menu to display the table of
contents menu.
4.6.1.2. B Figures menu
Select option B from the main menu to display the figures menu.
4.6.1.3. C Tables menu
Select option C from the main menu to display the tables menu.
4.6.1.4. D Document format menu, part 1
Select option D from the main menu to display part 1 of the
document format menu.
4.6.1.5. E Document format menu, part 2
Select option E from the main menu to display part 2 of the
document format menu.
Copyright (C) The Nunnery Works Ltd 1987 Page 4-8
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.1.6. F Document format menu, part 3
Select option F from the main menu to display part 3 of the
document format menu.
4.6.1.7. G Miscellaneous menu
Select option G from the main menu to display the miscellaneous
menu.
4.6.1.8. X Exit this program
Select option X from the main menu to exit from MSPC and return
to MS-DOS or PC-DOS.
Before MSPC returns to DOS, it offers you the opportunity to save
your configuration changes in a new disk file. To save the new
configuration, reply Y to the question and supply the desired
filename.
__________________________________________________________
MAIN MENU
Option Description
A . . Table of contents menu
B . . Figures menu
C . . Tables menu
D . . Document format menu, part 1
E . . Document format menu, part 2
F . . Document format menu, part 3
G . . Miscellaneous menu
X . . Exit this program
__________________________________________________________
Figure 4-2: Main Menu
Copyright (C) The Nunnery Works Ltd 1987 Page 4-9
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.2. Table of Contents Menu 4.6.2. Table of Contents Menu
Figure 4-3 on page 4-12 illustrates the contents of the MSPC
table of contents menu.
The following paragraphs describe each of the table of contents
menu options.
4.6.2.1. A Display all table of contents parameters
Select option A from the table of contents menu to display the
current values for the following items:
1) the table of contents page heading
2) the table of contents page heading print attributes
3) the number of paragraph level numbers that will
appear in the table of contents
4) whether table of contents entries are indented
5) the maximum number of lines on each page in the table
of contents
6) the level 1 heading print attributes
7) the level 2 heading print attributes
8) the level 3 heading print attributes
9) the level 4 heading print attributes
10) the level 5 heading print attributes
11) the level 6 heading print attributes
12) the level 7 heading print attributes
13) the level 8 heading print attributes
14) the level 9 heading print attributes
4.6.2.2. B Change table of contents page heading
Select option B from the table of contents menu to change the
heading MSPANTOC puts at the top of each page of the table of
contents.
The default value for this heading is
TABLE OF CONTENTS
and the maximum length of the heading is 80 characters.
Copyright (C) The Nunnery Works Ltd 1987 Page 4-10
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.2.3. C Change table of contents page heading print
attributes
Select option C from the table of contents menu to change the
print attributes MSPANTOC outputs along with the table of
contents page heading.
MSPANTOC will accept a maximum of 5 print attributes.
By default, MSPANTOC does not output any print attributes along
with the table of contents page heading.
4.6.2.4. D Change number of levels in table of contents
Select option D from the table of contents menu to change the
maximum number of levels that will appear in the table of
contents.
The maximum number of levels in the table of contents is 9 and
the minimum is 1.
By default, MSPANTOC will only include entries in the table of
contents for section numbers of 3 levels or less.
4.6.2.5. E Change indentation in table of contents
Select option E from the table of contents menu to select whether
MSPANTOC should indent table of contents entries or not.
Figure 4-4 on page 4-13 shows an example of a table of contents
created with indentation and figure 4-5 on page 4-13 shows an
example of a table of contents without indentation.
4.6.2.6. F Change max lines on table of contents page
Select option F from the table of contents menu to change the
maximum number of lines MSPANTOC will write on each page of the
table of contents.
The default value is 50 lines.
Copyright (C) The Nunnery Works Ltd 1987 Page 4-11
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.2.7. G-O Change print attributes for level 1-9 headings
Select options G-O from the table of contents menu to change the
print attributes MSPANTOC outputs along with the section heading
for a level 1-9, respectively, table of contents entry.
MSPANTOC will accept a maximum of 5 print attributes.
By default, MSPANTOC does not output any print attributes along
with a level 1-9 table of contents entry.
4.6.2.8. X Exit to main menu
Select option X from the table of contents menu to return to the
main menu.
__________________________________________________________
TABLE OF CONTENTS MENU
Option Description
A . . Display all table of contents parameters
B . . Change table of contents page heading
C . . Change table of contents page heading print attributes
D . . Change number of paragraph levels in table of contents
E . . Change indentation in table of contents
F . . Change max lines on table of contents page
G . . Change print attributes for level 1 heading
H . . Change print attributes for level 2 heading
I . . Change print attributes for level 3 heading
J . . Change print attributes for level 4 heading
K . . Change print attributes for level 5 heading
L . . Change print attributes for level 6 heading
M . . Change print attributes for level 7 heading
N . . Change print attributes for level 8 heading
O . . Change print attributes for level 9 heading
X . . Exit to main menu
__________________________________________________________
Figure 4-3: Table of Contents Menu
Copyright (C) The Nunnery Works Ltd 1987 Page 4-12
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
___________________________________________________________
1. INTRODUCTION . . . . . . . . . . . . . . . . . . 1-1
1.1. Purpose of This Manual . . . . . . . . . . 1-1
1.2. MSPANTOC . . . . . . . . . . . . . . . . . 1-1
1.2.1. Paragraph/Section Numbering . . . . . 1-1
1.2.2. Figure Numbering . . . . . . . . . . 1-1
1.2.3. Table Numbering . . . . . . . . . . 1-1
1.2.4. Symbolic Cross References . . . . . . 1-1
1.3. Some Fine Print . . . . . . . . . . . . . . 1-3
___________________________________________________________
Figure 4-4: Table of Contents, With Indentation
___________________________________________________________
1. INTRODUCTION . . . . . . . . . . . . . . 1-1
1.1. Purpose of This Manual . . . . . . . . . 1-1
1.2. MSPANTOC . . . . . . . . . . . . . . . . 1-1
1.2.1. Paragraph/Section Numbering . . . . . . 1-1
1.2.2. Figure Numbering . . . . . . . . . . . . 1-1
1.2.3. Table Numbering . . . . . . . . . . . . 1-1
1.3. Some Fine Print . . . . . . . . . . . . 1-5
___________________________________________________________
Figure 4-5: Table of Contents, No Indentation
___________________________________________________________
1. INTRODUCTION . . . . . . . . . . . . . . . . . . 1-1
1. Purpose of This Manual . . . . . . . . . . . 1-1
2. MSPANTOC . . . . . . . . . . . . . . . . . . 1-1
1. Paragraph/Section Numbering . . . . . . . 1-1
2. Figure Numbering . . . . . . . . . . . . . 1-1
3. Table Numbering . . . . . . . . . . . . . 1-1
4. Symbolic Cross References . . . . . . . . 1-1
5. Table of Contents . . . . . . . . . . . . 1-2
3. Some Fine Print . . . . . . . . . . . . . . . 1-5
___________________________________________________________
Figure 4-6: Table of Contents, Lowest Level Only
Copyright (C) The Nunnery Works Ltd 1987 Page 4-13
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.3. Figures menu 4.6.3. Figures menu
Figure 4-7 on page 4-16 illustrates the contents of the MSPC
figures menu.
The following paragraphs describe each of the figures menu
options.
4.6.3.1. A Display all figures parameters
Select option A from the figures menu to display the current
values for the following items:
1) the list of figures page heading
2) the list of figures page heading print attributes
3) the figures caption
4) the figure numbering format
5) the figure number punctuation
6) the figure description line print attributes
7) the maximum number of lines on a list of figures
page
4.6.3.2. B Change list of figures page heading
Select option B from the figures menu to change the heading
MSPANTOC puts at the top of each page of the list of figures.
The default value for this heading is
LIST OF FIGURES
and the maximum length of the heading is 80 characters.
4.6.3.3. C Change list of figures page heading print attributes
Select option C from the figures menu to change the print
attributes MSPANTOC outputs along with the list of figures page
heading.
MSPANTOC will accept a maximum of 5 print attributes.
By default, MSPANTOC does not output any print attributes along
with the list of figures page heading.
Copyright (C) The Nunnery Works Ltd 1987 Page 4-14
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.3.4. D Change figures caption
Select option D from the figures menu to change the caption
MSPANTOC outputs before a figure number in both the output
document file and the list of figures.
The default value for this caption is
Figure
and the maximum length of the caption is 25 characters.
4.6.3.5. E Change figure numbering format
Select option E from the figures menu to change the way MSPANTOC
assigns figure numbers. MSPANTOC assigns figure numbers
sequentially within chapters or within the document as a whole.
When MSPANTOC numbers figures within chapters, figure numbers are
composed of 2 parts, separated by a dash (-). The first part of
the figure number is the current chapter number and it appears in
the same display format chosen for level 1 numbers. The second
part of the figure number is the sequential figure number within
the current chapter. MSPANTOC assigns the number 1 to the first
figure in a chapter. This number always appears in Arabic number
format.
When MSPANTOC numbers figures within the document as a whole, it
simply numbers figures sequentially, beginning at 1. This figure
number always appears in Arabic number format.
4.6.3.6. F Change figure number punctuation
Select option F from the figures menu to change the single
character of punctuation MSPANTOC outputs after a figure number.
The default value for this punctuation character is a colon (:).
Copyright (C) The Nunnery Works Ltd 1987 Page 4-15
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.3.7. G Change figure description line print attributes
Select option G from the figures menu to change the print
attributes MSPANTOC outputs along with the figure description.
MSPANTOC will accept a maximum of 5 print attributes.
By default, MSPANTOC does not output any print attributes along
with the figure description.
4.6.3.8. H Change max lines on list of figures page
Select option H from the figures menu to change the maximum
number of lines MSPANTOC will write on each page of the list of
figures.
The default value is 50 lines.
4.6.3.9. X Exit to main menu
Select option X from the figures menu to return to the main menu.
__________________________________________________________
FIGURES MENU
Option Description
A . . Display all figures parameters
B . . Change list of figures page heading
C . . Change list of figures page heading print attributes
D . . Change figures caption
E . . Change figure numbering format
F . . Change figure number punctuation
G . . Change figure description line print attributes
H . . Change max lines on list of figures page
X . . Exit to main menu
__________________________________________________________
Figure 4-7: Figures Menu
Copyright (C) The Nunnery Works Ltd 1987 Page 4-16
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.4. Tables menu 4.6.4. Tables menu
Figure 4-8 on page 4-19 illustrates the contents of the MSPC
tables menu.
The following paragraphs describe each of the tables menu
options.
4.6.4.1. A Display all table parameters
Select option A from the tables menu to display the current
values for the following items:
1) the list of tables page heading
2) the list of tables page heading print attributes
3) the tables caption
4) the table numbering format
5) the table number punctuation
6) the table description line print attributes
7) the maximum number of lines on each list of tables
page
4.6.4.2. B Change list of tables page heading
Select option B from the tables menu to change the heading
MSPANTOC puts at the top of each page of the list of tables.
The default value for this heading is
LIST OF TABLES
and the maximum length of the heading is 80 characters.
4.6.4.3. C Change list of tables page heading print attributes
Select option C from the tables menu to change the print
attributes MSPANTOC outputs along with the list of tables page
heading.
MSPANTOC will accept a maximum of 5 print attributes.
By default, MSPANTOC does not output any print attributes along
with the list of tables page heading.
Copyright (C) The Nunnery Works Ltd 1987 Page 4-17
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.4.4. D Change tables caption
Select option D from the tables menu to change the caption
MSPANTOC outputs before a table number in both the output
document file and the list of tables.
The default value for this caption is
Table
and the maximum length of the caption is 25 characters.
4.6.4.5. E Change table numbering format
Select option E from the tables menu to change the way MSPANTOC
assigns table numbers. MSPANTOC assigns table numbers
sequentially within chapters or within the document as a whole.
When MSPANTOC numbers tables within chapters, table numbers are
composed of 2 parts, separated by a dash (-). The first part of
the table number is the current chapter number and it appears in
the same display format chosen for level 1 numbers. The second
part of the table number is the sequential table number within
the current chapter. MSPANTOC assigns the number 1 to the first
table in a chapter. This number always appears in Arabic number
format.
When MSPANTOC numbers tables within the document as a whole, it
simply numbers tables sequentially, beginning at 1. This table
number always appears in Arabic number format.
4.6.4.6. F Change table number punctuation
Select option F from the tables menu to change the single
character of punctuation MSPANTOC outputs after a table number.
The default value for this punctuation character is a colon (:).
Copyright (C) The Nunnery Works Ltd 1987 Page 4-18
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.4.7. G Change table description line print attributes
Select option G from the tables menu to change the print
attributes MSPANTOC outputs along with the table description.
MSPANTOC will accept a maximum of 5 print attributes.
By default, MSPANTOC does not output any print attributes along
with the table description.
4.6.4.8. H Change max lines on list of tables page
Select option H from the tables menu to change the maximum number
of lines MSPANTOC will write on each page of the list of tables.
The default value is 50 lines.
4.6.4.9. X Exit to main menu
Select option X from the tables menu to return to the main menu.
__________________________________________________________
TABLES MENU
Option Description
A . . Display all table parameters
B . . Change list of tables page heading
C . . Change list of tables page heading print attributes
D . . Change tables caption
E . . Change table numbering format
F . . Change table number punctuation
G . . Change table description line print attributes
H . . Change max lines on list of tables page
X . . Exit to main menu
__________________________________________________________
Figure 4-8: Tables Menu
Copyright (C) The Nunnery Works Ltd 1987 Page 4-19
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.5. Document format menu, part 1 4.6.5. Document format menu, part 1
Figure 4-9 on page 4-21 illustrates the contents of part 1 of the
MSPC document format menu.
The following paragraphs describe each of the document format,
part 1, menu options.
4.6.5.1. A Display part 1 document parameters
Select option A from part 1 of the document format menu to
display the current values for the following items:
1) level 1 heading print attributes
2) level 2 heading print attributes
3) level 3 heading print attributes
4) level 4 heading print attributes
5) level 5 heading print attributes
6) level 6 heading print attributes
7) level 7 heading print attributes
8) level 8 heading print attributes
9) level 9 heading print attributes
4.6.5.2. B-J Change print attributes for level 1-9 headings
Select options B-J from the part 1 document format menu to change
the print attributes MSPANTOC outputs along with a level 1-9
section heading in the main document.
MSPANTOC will accept a maximum of 5 print attributes.
By default, MSPANTOC does not output any print attributes along
with a section heading.
4.6.5.3. X Exit to main menu
Select option X from part 1 of the document format menu to return
to the main menu.
Copyright (C) The Nunnery Works Ltd 1987 Page 4-20
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
__________________________________________________________
MAIN DOCUMENT MENU, PART 1
Option Description
A . . Display part 1 document parameters
B . . Change print attributes for level 1 heading
C . . Change print attributes for level 2 heading
D . . Change print attributes for level 3 heading
E . . Change print attributes for level 4 heading
F . . Change print attributes for level 5 heading
G . . Change print attributes for level 6 heading
H . . Change print attributes for level 7 heading
I . . Change print attributes for level 8 heading
J . . Change print attributes for level 9 heading
K . . Change page numbering format
X . . Exit to main menu
__________________________________________________________
Figure 4-9: Document Menu, Part 1
__________________________________________________________
MAIN DOCUMENT MENU, PART 2
Option Description
A . . Display part 2 document parameters
B . . Change display format for paragraph number level 1
C . . Change display format for paragraph number level 2
D . . Change display format for paragraph number level 3
E . . Change display format for paragraph number level 4
F . . Change display format for paragraph number level 5
G . . Change display format for paragraph number level 6
H . . Change display format for paragraph number level 7
I . . Change display format for paragraph number level 8
J . . Change display format for paragraph number level 9
X . . Exit to main menu
__________________________________________________________
Figure 4-10: Document Menu, Part 2
Copyright (C) The Nunnery Works Ltd 1987 Page 4-21
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.6. Document format menu, part 2 4.6.6. Document format menu, part 2
Figure 4-10 on page 4-21 illustrates the contents of part 2 of
the MSPC document format menu.
The following paragraphs describe each of the document format,
part 2, menu options.
4.6.6.1. A Display part 2 document parameters
Select option A from part 2 of the document format menu to
display the current values for the following items:
1) paragraph number level 1 display format
2) paragraph number level 2 display format
3) paragraph number level 3 display format
4) paragraph number level 4 display format
5) paragraph number level 5 display format
6) paragraph number level 6 display format
7) paragraph number level 7 display format
8) paragraph number level 8 display format
9) paragraph number level 9 display format
4.6.6.2. B-J Change display format for paragraph number level 1-
9
Select options B-J from part 2 of the document format menu to
change the format MSPANTOC uses to display each level, 1-9
respectively, of a section or paragraph number.
MSPANTOC supports 5 display formats:
1) Arabic numbers
2) upper case Roman numerals
3) lower case Roman numerals
4) upper case alphabetics
5) lower case alphabetics
Arabic numerals are ordinary numbers, 1, 2, 3, 4, ...
Upper case Roman numerals, I, II, III, IV, ... range up to a
maximum of XCIX (99).
Copyright (C) The Nunnery Works Ltd 1987 Page 4-22
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
Lower case Roman numerals, i, ii, iii, iv, ... range up to a
maximum of xcix (99).
Upper case alphabetics, A, B, C, ..., Z, AA, AB, ..., AZ, BA, BB,
..., BZ, CA, CB, ... range up to a maximum of CU (99).
Lower case alphabetics, a, b, c, ..., z, aa, ab, ..., az, ba, bb,
..., bz, ca, cb, ... range up to a maximum of cu (99).
The default display format is Arabic numbers.
Figure 4-11 on page 4-23 show a table of contents fragment for a
document with the following numbering format
Level Format
1 Arabic
2 Upper case Roman numerals
3 Lower case alphabetics
4.6.6.3. X Exit to main menu
Select option X from part 2 of the document format menu to return
to the main menu.
__________________________________________________________
1. INTRODUCTION . . . . . . . . . . . . . . . . . 1-1
1.I. Purpose of This Manual . . . . . . . . . 1-1
1.II. MSPANTOC . . . . . . . . . . . . . . . . 1-1
1.II.a. Paragraph/Section Numbering . . . 1-1
1.II.b. Figure Numbering . . . . . . . . 1-1
1.II.c. Table Numbering . . . . . . . . 1-1
1.II.d. Symbolic Cross References . . . 1-1
1.II.e. Table of Contents . . . . . . . 1-2
1.II.f. List of Figures . . . . . . . . 1-2
1.III. Some Fine Print . . . . . . . . . . . . 1-5
1.IV. System Requirements . . . . . . . . . . 1-6
__________________________________________________________
Figure 4-11: Table of Contents, Differing Number Systems
Copyright (C) The Nunnery Works Ltd 1987 Page 4-23
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.7. Document format menu, part 3 4.6.7. Document format menu, part 3
Figure 4-12 on page >>doc3men illustrates the contents of part 3
of the MSPC document format menu.
The following paragraphs describe each of the document format,
part 3, menu options.
4.6.7.1. A Display part 3 document parameters
Select option A from part 3 of the document format menu to
display the current values for the following items:
1) the paragraph number level 1 punctuation
2) the paragraph number level 2 punctuation
3) the paragraph number level 3 punctuation
4) the paragraph number level 4 punctuation
5) the paragraph number level 5 punctuation
6) the paragraph number level 6 punctuation
7) the paragraph number level 7 punctuation
8) the paragraph number level 8 punctuation
9) the paragraph number level 9 punctuation
4.6.7.2. B-J Change paragraph number level 1-9 punctuation
Select options B-J from part 3 of the document format menu to
change the single character of punctuation MSPANTOC outputs after
each level, 1-9 respectively, of a section or paragraph number.
The default value for this punctuation character is a period (.).
4.6.7.3. X Exit to main menu
Select option X from part 3 of the document format menu to return
to the main menu.
Copyright (C) The Nunnery Works Ltd 1987 Page 4-24
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.8. Miscellaneous menu 4.6.8. Miscellaneous menu
Figure 4-13 on page 4-26 illustrates the contents of the MSPC
miscellaneous menu.
The following paragraphs describe each of the miscellaneous menu
options.
4.6.8.1. A Display all miscellaneous values
Select option A from the miscellaneous menu to display the
current values for the following items:
1) all valid print attribute codes
2) the paragraph number lead-in string
4.6.8.2. B Change lead-in string
Select option B from the miscellaneous menu to change the lead-in
string. A lead-in string is a pre-defined sequence of from 1 to
3 characters which identify for MSPANTOC and visually highlight
the next 1 or 2 characters in a text file as an action request
code.
The default lead-in string is the 2 character sequence
=>
4.6.8.3. C Change line termination sequence
Select option C from the miscellaneous menu to change the line
termination sequence MSPANTOC uses to end each line in the table
of contents, list of figures and list of tables that it creates.
The default line termination sequence is a carriage return and a
line feed. If you use WordPerfect, select a line termination
sequence of a line feed only.
The line termination sequence needs changing if your word
processing package prints the table of contents, list of figures
or list of tables double spaced, all on one line or in some other
incorrect fashion.
Copyright (C) The Nunnery Works Ltd 1987 Page 4-25
MSPANTOC Version 1.0 CONFIGURING MSPANTOC
4.6.8.4. X Exit to main menu
Select option X from the miscellaneous menu to return to the main
menu.
__________________________________________________________
MAIN DOCUMENT MENU, PART 3
Option Description
A . . Display part 3 document parameters
B . . Change paragraph number level 1 punctuation
C . . Change paragraph number level 2 punctuation
D . . Change paragraph number level 3 punctuation
E . . Change paragraph number level 4 punctuation
F . . Change paragraph number level 5 punctuation
G . . Change paragraph number level 6 punctuation
H . . Change paragraph number level 7 punctuation
I . . Change paragraph number level 8 punctuation
J . . Change paragraph number level 9 punctuation
X . . Exit to main menu
__________________________________________________________
Figure 4-12: Document Menu, Part 3
__________________________________________________________
MISCELLANEOUS VALUES MENU
Option Description
A . . Display all miscellaneous values
B . . Change lead-in string
C . . Change line termination sequence
X . . Exit to main menu
__________________________________________________________
Figure 4-13: Miscellaneous Values Menu
Copyright (C) The Nunnery Works Ltd 1987 Page 4-26
MSPANTOC Version 1.0 RUNNING MSPANTOC
5. RUNNING MSPANTOC 5. RUNNING MSPANTOC ___________________
5.1. Introduction 5.1. Introduction
This chapter describes how to run MSPANTOC. It describes the
command line format, the status and error messages and summarizes
the operation of the program.
5.2. Command Line Format 5.2. Command Line Format
To run the MSPANTOC program, enter a command line with the form
MSP10 control-file configuration-file/C
where:
1) MSP10 is the name of the MSPANTOC executable program,
version 1.0
2) control-file is the full pathname of the control file
3) configuration-file is the full pathname of the
optional configuration file
5.2.1. Control File 5.2.1. Control File
The control file is a standard MS-DOS or PC-DOS text file which
you must create. It contains an ordered list of the names of the
text files that make up your document.
If you follow our suggestions, the control file contains a list,
one per line, of the full pathnames of the individual chapter
files for your document in the order they are to appear in the
final document.
MSPANTOC reads each input text file, assigns section, paragraph,
figure and table numbers, resolves cross references and writes
the updated text files to disk using file names with extensions
of APN (assigned paragraph numbers).
In addition, MSPANTOC uses the root of the full control file
pathname as the root for the table of contents pathname, list of
figures pathname and list of tables pathname. The root of a
pathname is the drive designation, all directory names and the
filename without any extension, ie all characters up to the dot
which separates the filename from its extension.
Copyright (C) The Nunnery Works Ltd 1987 Page 5-1
MSPANTOC Version 1.0 RUNNING MSPANTOC
For example, if your document consists of 5 chapters organized
into the following files: INTRO.DOC, COMPLIANCE.DOC, TECH.DOC,
PRICE.DOC and SPECS.DOC, then the control file would contain 5
lines as follows:
INTRO.DOC
COMPLIANCE.DOC
TECH.DOC
PRICE.DOC
SPECS.DOC
5.2.2. Configuration File 5.2.2. Configuration File
The MSPANTOC configuration program creates the configuration
file. MSPANTOC reads the configuration file to obtain the
current settings for all user settable values.
If the command line does not reference a configuration file,
MSPANTOC attempts to read the configuration information from the
default configuration file name MSP.CFG.
5.3. Command Line Examples 5.3. Command Line Examples
1) MSP10 CONTROL.FIL
MSPANTOC reads the list of documents to process from the control
file named CONTROL.FIL.
MSPANTOC uses the configuration information in file MSP.CFG.
MSPANTOC builds
1) the table of contents in file CONTROL.TOC
2) the list of figures in file CONTROL.FIG
3) the list of tables in file CONTROL.TBL
2) MSP10 C:\DOCS\PROPOSAL.CTL PROPOSAL.CFG/C
MSPANTOC reads the list of documents to process from the control
file named C:\DOCS\PROPOSAL.CTL.
MSPANTOC uses the configuration information in the file named
PROPOSAL.CFG.
Copyright (C) The Nunnery Works Ltd 1987 Page 5-2
MSPANTOC Version 1.0 RUNNING MSPANTOC
MSPANTOC builds
1) the table of contents in file C:\DOCS\PROPOSAL.TOC
2) the list of figures in file C:\DOCS\PROPOSAL.FIG
3) the list of tables in file C:\DOCS\PROPOSAL.TBL
5.4. Displayed Messages 5.4. Displayed Messages
MSPANTOC displays 2 types of messages on the console display
screen while it is running, status messages and error messages.
The following 2 sections describe each of the possible status and
error messages that you might see.
5.4.1. Status Messages 5.4.1. Status Messages
5.4.1.1. Pass 1, file file-name
MSPANTOC displays a status message showing its progress through
your document. The status message identifies the current pass
number, 1 or 2, and the current input file being processed.
Section 5.5.4 on page 5-7 describes the 2 pass processing that
MSPANTOC performs.
5.4.2. Error Messages 5.4.2. Error Messages
5.4.2.1. Control file error, unexpected end of line or end of
file
MSPANTOC encountered one of 2 unexpected conditions while reading
the control file:
1) an empty line (no file name)
2) an unexpected end of file
5.4.2.2. File f-n does not contain a usable copy of configuration
data
MSPANTOC attempted to obtain configuration information from the
file named f-n in the message. This file does not contain a
usable copy of configuration data. Either the file was not
created by the MSPANTOC configuration program or it was created
by an old version of the configuration program.
Copyright (C) The Nunnery Works Ltd 1987 Page 5-3
MSPANTOC Version 1.0 RUNNING MSPANTOC
5.4.2.3. File write error, file file-name
MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
write to the file named file-name in the message. This could be
a transient disk error that will go away if you retry or it could
be permanent. It could be caused because there is not enough
room on the disk drive or because you have a write protected
diskette.
5.4.2.4. Input file read error, file file-name
MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
read from the file named file-name in the message. This could be
a transient disk error that will go away if you retry or it could
be permanent.
5.4.2.5. Insufficient memory for program execution
MSPANTOC attempts to build its table of symbols in memory it
obtains from the operating system. MS-DOS or PC-DOS reported
that there is not enough space to satisfy the request made by
MSPANTOC. Please report this problem to The Nunnery Works Ltd.
5.4.2.6. Invalid attribute code atr-code
MSPANTOC found a request to use the named attribute code but
there was no definition for this code in the attribute file when
the configuration program was run.
5.4.2.7. Invalid command line format
MSPANTOC detected an error in the command line.
5.4.2.8. Level number N too large for conversion to roman
numerals
MSPANTOC will convert level numbers from 1-99 to Roman numerals.
The number reported in the message (N) is outside this range.
Copyright (C) The Nunnery Works Ltd 1987 Page 5-4
MSPANTOC Version 1.0 RUNNING MSPANTOC
5.4.2.9. Level number N too large for conversion to alpha
MSPANTOC will convert level numbers from 1-99 to an alphabetic
level number. The number reported in the message (N) is outside
this range.
5.4.2.10. No room for symbol symbol-name in file file-name
The symbol table is full and cannot hold the named symbol from
the named input file.
5.4.2.11. Room for N symbol table entries
Before MSPANTOC begins processing the input document, it checks
the amount of available memory reported by MS-DOS or PC-DOS. The
available memory is sufficient to hold a maximum of N symbol
table entries.
5.4.2.12. Symbol symbol-name in file file-name was previously
defined
Symbol names must be unique in their first 10 characters. The
named symbol from the named input file was previously defined
elsewhere in the document.
5.4.2.13. Unable to read configuration data from file file-name
MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
read configuration data from the file named file-name in the
message. This could be a transient disk error that will go away
if you retry or it could be permanent.
5.4.2.14. Unable to open configuration file file-name
MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
open the named configuration file. The named file probably does
not exist.
Copyright (C) The Nunnery Works Ltd 1987 Page 5-5
MSPANTOC Version 1.0 RUNNING MSPANTOC
5.4.2.15. Unable to open control file file-name
MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
open the named control file. The named file probably does not
exist.
5.4.2.16. Unable to open input file file-name
MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
open the named input document file. The named file probably does
not exist.
5.4.2.17. Unable to open list of figures file file-name
MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
open the named list of figures file.
5.4.2.18. Unable to open list of tables file file-name
MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
open the named list of tables file.
5.4.2.19. Unable to open output file file-name
MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
open the named output document file.
5.4.2.20. Unable to open table of contents file file-name
MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
open the named table of contents file.
5.4.2.21. Undefined symbol symbol-name in file file-name
MSPANTOC has made one complete pass through the entire document
and is now making a second pass through the named document file.
The named symbol has not been defined anywhere in the document.
Section 5.5.4 on page 5-7 describes the 2 pass processing that
MSPANTOC performs.
Copyright (C) The Nunnery Works Ltd 1987 Page 5-6
MSPANTOC Version 1.0 RUNNING MSPANTOC
5.5. Processing Summary 5.5. Processing Summary
Figure 5-1 on page 5-9 summarizes the processing performed by
MSPANTOC.
MSPANTOC reads all files on the left side of the figure and
creates all files on the right side.
5.5.1. Command Line 5.5.1. Command Line
MSPANTOC obtains the pathnames of the control file and the
configuration file from the command line you enter.
5.5.2. Control File 5.5.2. Control File
The control file contains an ordered list of the text files that
compose your document. MSPANTOC obtains the pathnames of the
text files from this file and reads the text files in the order
they appear in the control file.
MSPANTOC also uses the root of the control file name as the root
of the table of contents, list of figures and list of tables
files that it creates.
5.5.3. Configuration File 5.5.3. Configuration File
MSPANTOC reads the configuration file to obtain the current
settings of all user settable values. If the command line does
not contain a configuration file name, MSPANTOC uses the file
name MSP.CFG as a default.
5.5.4. Input Text Files 5.5.4. Input Text Files
MSPANTOC makes two passes through the list of input text files.
On the first pass, MSPANTOC reads each text file in the list. On
the second pass, MSPANTOC reads only those text files it found to
contain references to symbols not yet defined at the time of the
first pass.
Copyright (C) The Nunnery Works Ltd 1987 Page 5-7
MSPANTOC Version 1.0 RUNNING MSPANTOC
5.5.5. Table of Contents File 5.5.5. Table of Contents File
MSPANTOC creates a table of contents file using the root of the
control file pathname and the extension TOC. The table of
contents contains the section number, section description and
page number for each section you identify in your document.
MSPANTOC builds the table of contents using the format you
requested in the configuration file.
5.5.6. List of Figures File 5.5.6. List of Figures File
MSPANTOC creates a list of figures file using the root of the
control file pathname and the extension FIG. The list of figures
contains the table number, figure description and page number for
each figure you identify in your document.
5.5.7. List of Tables File 5.5.7. List of Tables File
MSPANTOC creates a list of tables file using the root of the
control file pathname and the extension TBL. The list of tables
contains the table number, table description and page number for
each table you identify in your document.
5.5.8. Output Text Files 5.5.8. Output Text Files
MSPANTOC creates one output text file for each input text file
listed in the control file. The output text file name uses the
root of the input text file pathname and the extension APN
(assigned paragraph numbers).
The output text file is an almost exact copy of the input text
file. The only changes that MSPANTOC makes are as follows:
1) it assigns paragraph, section, figure or table
numbers where requested
2) it removes symbol names from paragraph, section,
figure or table number assignment requests
3) it inserts chapter numbers where requested
4) it resolves cross references where requested
5) it inserts print attribute control strings where
requested
Copyright (C) The Nunnery Works Ltd 1987 Page 5-8
MSPANTOC Version 1.0 RUNNING MSPANTOC
----------------
Command Line -----> | | Table of Contents
| M |
| S | -------------
Configuration ---> | P | | |
File | A | --> | XXX.TOC |
| N | | |
Control File -----> | T | -------------
| O |
(XXX.CTL) | C |
------------- | | List of Figures
| | | |
| CHAP1.DOC | | | -------------
| CHAP2.DOC | | | | |
| . | | | --> | XXX.FIG |
| . | | | | |
| CHAPN.DOC | | | -------------
| | | |
------------- | | List of Tables
| |
| | -------------
| | | |
| | --> | XXX.TBL |
| | | |
| | -------------
| |
Text Files | | Text Files
| |
------------- | | -------------
| | | | | |
| CHAP1.DOC |--> | | --> | CHAP1.APN |
| | | | | |
------------- | | -------------
| |
------------- | | -------------
| | | | | |
| CHAP2.DOC |--> | | --> | CHAP2.APN |
| | | | | |
------------- | | -------------
| |
------------- | | -------------
| | | | | |
| CHAPN.DOC |--> | | --> | CHAPN.APN |
| | | | | |
------------- | | -------------
----------------
Figure 5-1: MSPANTOC Processing Summary
Copyright (C) The Nunnery Works Ltd 1987 Page 5-9
MSPANTOC Version 1.0 PRINTING A DOCUMENT
6. PRINTING A DOCUMENT 6. PRINTING A DOCUMENT ______________________
6.1. Introduction 6.1. Introduction
This chapter describes how to print a document and assumes that
you accepted our suggestion and created a series of individual
files, each containing a single chapter.
6.2. After MSPANTOC Runs 6.2. After MSPANTOC Runs
MSPANTOC writes its output to files with suffixes of APN with one
such file created for each entry in the control file. MSPANTOC
also creates a table of contents file, a list of figures file and
a list of tables file. The problem is to combine these files
into a complete document.
6.3. A General Solution 6.3. A General Solution
Assume that your control file named CTL.FIL contains the
following:
INTRO.DOC
COMPLIANCE.DOC
PRICE.DOC
SPECS.DOC
and that you have also created a document header page in file
HEADER.DOC.
Then, in general, you want the files printed in the following
order:
HEADER.DOC
CTL.TOC the table of contents file
CTL.FIG the list of figures file
CTL.TBL the list of tables file
INTRO.APN
COMPLIANCE.APN
PRICE.APN
SPECS.APN
The following sections describe how to do this in WordStar and
WordPerfect.
Copyright (C) The Nunnery Works Ltd 1987 Page 6-1
MSPANTOC Version 1.0 PRINTING A DOCUMENT
6.4. Using WordStar with MailMerge 6.4. Using WordStar with MailMerge
To print this document with WordStar if you also have MailMerge,
proceed as follows:
1) Create a file called MASTER.LST with the following
contents:
.FI HEADER.DOC
.FI CTL.TOC
.FI CTL.FIG
.FI CTL.TBL
.FI INTRO.APN
.FI COMPLIANCE.APN
.FI PRICE.APN
.FI SPECS.APN
2) Select the merge print option from your WordStar main
menu and specify file name MASTER.LST. MailMerge will
merge all the files listed in MASTER.LST into a single
printed document.
6.5. Using WordStar without MailMerge 6.5. Using WordStar without MailMerge
To print this document with WordStar if you do not have
MailMerge, proceed as follows:
1) Select the print option (P) from your WordStar main
menu and specify file HEADER.DOC. WordStar will
print the document header page, HEADER.DOC.
2) Repeat this procedure for each of the following files,
in order:
CTL.TOC
CTL.FIG
CTL.TBL
INTRO.APN
COMPLIANCE.APN
PRICE.APN
SPECS.APN
Copyright (C) The Nunnery Works Ltd 1987 Page 6-2
MSPANTOC Version 1.0 PRINTING A DOCUMENT
6.6. Using WordPerfect 6.6. Using WordPerfect
To print this document with WordPerfect, proceed as follows:
1) Create a file called MASTER.LST with the following
contents:
^PHEADER.DOC^P
^PCTL.TOC^P
^PCTL.FIG^P
^PCTL.TBL^P
^PINTRO.APN^P
^PCOMPLIANCE.APN^P
^PPRICE.APN^P
^PSPECS.APN^P
Note that ^P respresents control-P.
2) Press the EXECUTE-MERGE function key.
3) Specify MASTER.LST as the primary file name and just
ENTER for the secondary file name.
4) WordPerfect merges the files listed in MASTER.LST into
a complete document. When the merge completes, you have
the option of saving the merged document to disk for
later printing or printing immediately.
Copyright (C) The Nunnery Works Ltd 1987 Page 6-3